List Documents
AutomatR.DocuSign.Activities.ListDocuments
The "List Documents" activity in AutomatR is part of the DocuSign Document package, providing functionality to retrieve a list of documents associated with a specific envelope in DocuSign. This activity offers flexibility in filtering documents based on user ID, including metadata and tabs in the response, and more.
Properties
| Name | Description |
|---|---|
| Input | |
| Envelope ID | Enter the Envelope ID to identify the DocuSign envelope for which documents need to be retrieved. This field supports only Strings or String variables. |
| Documents By User ID | Enter "true" or "false" to indicate whether to filter the envelope documents by user ID. If set to "true," recipient ID should not be provided. If set to "false," provide the recipient ID. String variables containing the value. |
| Include Metadata | Specify whether to include document metadata in the response. Enter "true" or "false." String variables containing the value. |
| Include Tabs | Specify whether to include document tabs in the response. Enter "true" or "false." String variables containing the value. |
| Recipient ID | Enter the recipient ID to filter envelope documents. Provide this value only if "Documents By User ID" is set to "false." String variables containing the recipient ID. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "List Documents" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Output | |
| Response | Returns the envelope documents with data type EnvelopeDocumentsResult. Variables of data type EnvelopeDocumentsResult to store the document details. |
How to use:
- Drag and drop the "List Documents" activity onto the workflow.
- Configure the properties by specifying the Envelope ID and optionally, other filtering parameters.
- Execute the workflow to retrieve information about documents associated with the specified envelope.
Important Notes:
- Ensure that the "List Documents" activity is used within the scope of the "DocuSign Scope" activity.
- Carefully set the "Documents By User ID" property to "true" or "false" based on the desired filtering criteria.
Example: Consider an example where the "List Documents" activity is used to retrieve documents associated with an envelope:
List Documents:
Delay: 5
Envelope ID: "env123"
Documents By User ID: "true"
Include Metadata: "false"
Include Tabs: "true"
Response: envelopeDocumentsInfo
In this example, the activity waits for 5 seconds (as specified in the Delay property) and then retrieves information about documents associated with the envelope having ID "env123." The details of the documents are stored in the variable "envelopeDocumentsInfo" for further processing in the workflow.